Skip to content

docs: advertise the llms.txt documentation index in AGENTS.md - #2

Merged
soyuka merged 1 commit into
mainfrom
feat/agents-md-llms
Jun 14, 2026
Merged

docs: advertise the llms.txt documentation index in AGENTS.md#2
soyuka merged 1 commit into
mainfrom
feat/agents-md-llms

Conversation

@soyuka

@soyuka soyuka commented Jun 13, 2026

Copy link
Copy Markdown
Member

Follow-up to #1. Points agents at the machine-readable llms.txt index, not just the human docs:

Kept lean (two lines in the intro). The index itself is shipped by api-platform/docs-website#29 + api-platform/docs#2302; the URL goes live on the next docs deploy.

Point agents at https://api-platform.com/docs/llms.txt (and llms-full.txt),
the machine-readable index, alongside the human-readable docs.
soyuka added a commit to soyuka/api-platform that referenced this pull request Jun 13, 2026
soyuka added a commit to api-platform/api-platform that referenced this pull request Jun 14, 2026
…2993)

* feat(installer): scaffold AGENTS.md and CLAUDE.md into new projects

New projects ship agent-instruction files by default so AI coding agents
read current API Platform docs instead of stale training data. AGENTS.md
is the cross-agent convention (Cursor, GitHub Copilot, OpenAI Codex,
Gemini); CLAUDE.md is a thin @AGENTS.md import. Opt out with --no-with-agents.

Adds an AgentsScaffold writer (templates/AGENTS.md, templates/CLAUDE.md), a
withAgents option on ScaffoldOptions (default true), and wires both the
Symfony and Laravel scaffolds. Content matches the api-platform/skillset
AGENTS.md. Mirrors create-next-app's agent-file generation.

* docs(installer): advertise llms.txt index in the scaffolded AGENTS.md

Keep the template in sync with api-platform/skillset#2 — point agents at
https://api-platform.com/docs/llms.txt and llms-full.txt.

* refactor(installer): fetch AGENTS.md from skillset instead of bundling it

Make api-platform/skillset the single source of truth: AgentsScaffold now
downloads AGENTS.md from the skillset main branch at scaffold time rather
than shipping a bundled copy that drifts (the template and its later
llms.txt update both had to be hand-synced). The fetch is injectable so
tests stay offline, and a failed download warns and skips rather than
aborting the scaffold. CLAUDE.md (@AGENTS.md) is written inline; the
bundled templates are removed.
@soyuka
soyuka merged commit c8248d4 into main Jun 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant